<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Class bmqa::CloseQueueStatus</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqa.html">bmqa</a>      </li>
      <li><a class="el" href="classbmqa_1_1CloseQueueStatus.html">bmqa::CloseQueueStatus</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>bmqa::CloseQueueStatus Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqa::CloseQueueStatus" -->
<p><code>#include &lt;<a class="el" href="bmqa__closequeuestatus_8h_source.html">bmqa_closequeuestatus.h</a>&gt;</code></p>

<p><a href="classbmqa_1_1CloseQueueStatus-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#a5f85594c0fe3bf495efca78f0a5a531b">CloseQueueStatus</a> (bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#afb484c50490844afece7c846856d9275">CloseQueueStatus</a> (const <a class="el" href="classbmqa_1_1CloseQueueStatus.html">bmqa::CloseQueueStatus</a> &amp;other, bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#a07c813c425851d8a0333550877ec2cd3">CloseQueueStatus</a> (const <a class="el" href="classbmqa_1_1QueueId.html">QueueId</a> &amp;queueId, <a class="el" href="structbmqt_1_1CloseQueueResult.html#a1db2302fd27c7ee989d0a5f95d400e2e">bmqt::CloseQueueResult::Enum</a> result, const bsl::string &amp;errorDescription, bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqa_1_1CloseQueueStatus.html">CloseQueueStatus</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#a6e32a45eed8b9f2977ea5f88394d5708">operator=</a> (const <a class="el" href="classbmqa_1_1CloseQueueStatus.html">CloseQueueStatus</a> &amp;rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#a8a869fb27847d2e6db289c26c3068ab1">operator bool</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbmqa_1_1QueueId.html">QueueId</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#ae20000475dc1272e65df7f227cf512ed">queueId</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbmqt_1_1CloseQueueResult.html#a1db2302fd27c7ee989d0a5f95d400e2e">bmqt::CloseQueueResult::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#ab432dad2d9cb46799885d59a6d878440">result</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const bsl::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#aacc1365faa92a6bda392bbabd67085f5">errorDescription</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bsl::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqa_1_1CloseQueueStatus.html#a1e7c1b2704018d2db6191dba0d47cd16">print</a> (bsl::ostream &amp;stream, int level=0, int spacesPerLevel=4) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A value-semantic type for a close queue operation with the message queue broker.</p>
<p>See <a class="el" href="group__bmqa__closequeuestatus.html">Component bmqa_closequeuestatus</a> </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5f85594c0fe3bf495efca78f0a5a531b"></a><!-- doxytag: member="bmqa::CloseQueueStatus::CloseQueueStatus" ref="a5f85594c0fe3bf495efca78f0a5a531b" args="(bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::CloseQueueStatus::CloseQueueStatus </td>
          <td>(</td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default constructor, use the optionally specified <code>allocator</code>. </p>

</div>
</div>
<a class="anchor" id="afb484c50490844afece7c846856d9275"></a><!-- doxytag: member="bmqa::CloseQueueStatus::CloseQueueStatus" ref="afb484c50490844afece7c846856d9275" args="(const bmqa::CloseQueueStatus &amp;other, bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::CloseQueueStatus::CloseQueueStatus </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1CloseQueueStatus.html">bmqa::CloseQueueStatus</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <code><a class="el" href="classbmqa_1_1CloseQueueStatus.html">bmqa::CloseQueueStatus</a></code> using the optionally specified <code>allocator</code>. </p>

</div>
</div>
<a class="anchor" id="a07c813c425851d8a0333550877ec2cd3"></a><!-- doxytag: member="bmqa::CloseQueueStatus::CloseQueueStatus" ref="a07c813c425851d8a0333550877ec2cd3" args="(const QueueId &amp;queueId, bmqt::CloseQueueResult::Enum result, const bsl::string &amp;errorDescription, bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::CloseQueueStatus::CloseQueueStatus </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1QueueId.html">QueueId</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>queueId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structbmqt_1_1CloseQueueResult.html#a1db2302fd27c7ee989d0a5f95d400e2e">bmqt::CloseQueueResult::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>result</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const bsl::string &amp;&nbsp;</td>
          <td class="paramname"> <em>errorDescription</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <code><a class="el" href="classbmqa_1_1CloseQueueStatus.html">bmqa::CloseQueueStatus</a></code> object having the specified <code>queueId</code>, <code>result</code>, and <code>errorDescription</code>, using the optionally specified <code>allocator</code> to supply memory. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6e32a45eed8b9f2977ea5f88394d5708"></a><!-- doxytag: member="bmqa::CloseQueueStatus::operator=" ref="a6e32a45eed8b9f2977ea5f88394d5708" args="(const CloseQueueStatus &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqa_1_1CloseQueueStatus.html">CloseQueueStatus</a>&amp; bmqa::CloseQueueStatus::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqa_1_1CloseQueueStatus.html">CloseQueueStatus</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>rhs</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Assign to this <code><a class="el" href="classbmqa_1_1CloseQueueStatus.html">CloseQueueStatus</a></code> the same values as the one from the specified <code>rhs</code>. </p>

</div>
</div>
<a class="anchor" id="a8a869fb27847d2e6db289c26c3068ab1"></a><!-- doxytag: member="bmqa::CloseQueueStatus::operator bool" ref="a8a869fb27847d2e6db289c26c3068ab1" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqa::CloseQueueStatus::operator bool </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return true if this result indicates success, and false otherwise. </p>

</div>
</div>
<a class="anchor" id="ae20000475dc1272e65df7f227cf512ed"></a><!-- doxytag: member="bmqa::CloseQueueStatus::queueId" ref="ae20000475dc1272e65df7f227cf512ed" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classbmqa_1_1QueueId.html">QueueId</a>&amp; bmqa::CloseQueueStatus::queueId </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the queueId associated to this operation result, if any. </p>

</div>
</div>
<a class="anchor" id="ab432dad2d9cb46799885d59a6d878440"></a><!-- doxytag: member="bmqa::CloseQueueStatus::result" ref="ab432dad2d9cb46799885d59a6d878440" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structbmqt_1_1CloseQueueResult.html#a1db2302fd27c7ee989d0a5f95d400e2e">bmqt::CloseQueueResult::Enum</a> bmqa::CloseQueueStatus::result </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the status code that indicates success or the cause of a failure. </p>

</div>
</div>
<a class="anchor" id="aacc1365faa92a6bda392bbabd67085f5"></a><!-- doxytag: member="bmqa::CloseQueueStatus::errorDescription" ref="aacc1365faa92a6bda392bbabd67085f5" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bsl::string&amp; bmqa::CloseQueueStatus::errorDescription </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return a printable description of the error, if <code>result</code> indicates failure. Return an empty string otherwise. </p>

</div>
</div>
<a class="anchor" id="a1e7c1b2704018d2db6191dba0d47cd16"></a><!-- doxytag: member="bmqa::CloseQueueStatus::print" ref="a1e7c1b2704018d2db6191dba0d47cd16" args="(bsl::ostream &amp;stream, int level=0, int spacesPerLevel=4) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bsl::ostream&amp; bmqa::CloseQueueStatus::print </td>
          <td>(</td>
          <td class="paramtype">bsl::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>level</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>spacesPerLevel</em> = <code>4</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Format this object to the specified output <code>stream</code> at the (absolute value of) the optionally specified indentation <code>level</code> and return a reference to <code>stream</code>. If <code>level</code> is specified, optionally specify <code>spacesPerLevel</code>, the number of spaces per indentation level for this and all of its nested objects. If <code>level</code> is negative, suppress indentation of the first line. If <code>spacesPerLevel</code> is negative format the entire output on one line, suppressing all but the initial indentation (as governed by <code>level</code>). If <code>stream</code> is not valid on entry, this operation has no effect. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bmqa__closequeuestatus_8h_source.html">bmqa_closequeuestatus.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:51 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
